Class: UserApi
UserApi - object-oriented interface
Export
Hierarchy
↳
UserApi
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new UserApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
userApiKeysGet
▸ userApiKeysGet(options?): Promise<MainGetApiKeysResp[]>
This endpoint is used to get API keys for a user. In estuary, each user can be given multiple API keys (tokens). This endpoint can be used to retrieve all available API keys for a given user.
Summary
Get API keys for a user
Throws
Memberof
UserApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<MainGetApiKeysResp[]>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7737
userApiKeysKeyDelete
▸ userApiKeysKeyDelete(key, options?): Promise<Response>
This endpoint is used to revoke a user API key. In estuary, every user is assigned with an API key, this API key is generated and issued for each user and is primarily use to access all estuary features. This endpoint can be used to revoke the API key thats assigned to the user.
Summary
Revoke a User API Key.
Throws
Memberof
UserApi
Parameters
| Name | Type | Description |
|---|---|---|
key | string | Key |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7749
userApiKeysPost
▸ userApiKeysPost(expiry?, perms?, options?): Promise<MainGetApiKeysResp>
This endpoint is used to create API keys for a user. In estuary, each user is given an API key to access all features.
Summary
Create API keys for a user
Throws
Memberof
UserApi
Parameters
| Name | Type | Description |
|---|---|---|
expiry? | string | Expiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h |
perms? | string | Permissions -- currently unused |
options? | any | Override http request option. |
Returns
Promise<MainGetApiKeysResp>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7762
userExportGet
▸ userExportGet(options?): Promise<string>
This endpoint is used to get API keys for a user.
Summary
Export user data
Throws
Memberof
UserApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<string>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:7773
userStatsGet
▸ userStatsGet(options?): Promise<MainUserStatsResponse>
This endpoint is used to create API keys for a user.
Summary
Create API keys for a user
Throws
Memberof
UserApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<MainUserStatsResponse>